API Change Logs
PAGE CONTENTS
If a table cell is empty it means there are no changes between that version and the previously-released version. Click the link text in a cell to see those changes.
Authentication | PlanningSpace | Dataflow | Economics | Economics Calculation | Financials | IPS Server Monitor Tenant API |
|
---|---|---|---|---|---|---|---|
16.5.1 | 16.5.1 changes | 16.5.1 changes | 16.5.1 changes | ||||
16.5.2 | |||||||
16.5.3 | |||||||
16.5.4 | |||||||
16.5.5 | |||||||
16.5.6 | 16.5.6 changes | ||||||
16.5.7 | 16.5.7 changes | 16.5.7 changes | 16.5.7 changes | ||||
16.5.8 | |||||||
16.5.9 | |||||||
16.5.10 | 16.5.10 changes | First release of API | 16.5.10 changes | ||||
16.5.11 | 16.5.11 changes | 16.5.11 changes | 16.5.11 changes | ||||
16.5.12 | 16.5.12 changes | ||||||
16.5.13 | 16.5.13 changes | 16.5.13 changes | 16.5.13 changes | ||||
16.5.14 | 16.5.14 changes | 16.5.14 changes | 16.5.14 changes | 16.5.14 changes | |||
16.5.15 | 16.5.15 changes | 16.5.15 changes | 16.5.15 changes | ||||
16.5.16 | 16.5.16 changes | 16.5.16 changes | |||||
16.5.22 | 16.5.22 changes | 16.5.22 changes | 16.5.22 changes | 16.5.22 changes | |||
16.5.23 | |||||||
16.5.24 | 16.5.24 changes | 16.5.24 changes | 16.5.24 changes | 16.5.24 changes | |||
16.5.25 | 16.5.25 changes | ||||||
16.5.26 | |||||||
16.5.27 | 16.5.27 changes | ||||||
16.5.28 | |||||||
16.5.29 | |||||||
16.5.30 | |||||||
16.5.31 | 16.5.31 changes | ||||||
16.5.32 | |||||||
16.5.33 |
Authentication: Change Log
Changes from version 16.5.6 to 16.5.7
New Windows authentication mode for OData endpoints. It is disabled by default and must be enabled by an IPS Administator. See Windows Authentication for OData.
New optional IPS service setting 'API Key Lifetime' which sets an expiration date for API keys (specific number of days after generation). The default setting is that expiry is disabled and API keys will have unlimited validity (i.e., the same as earlier versions of PlanningSpace). See Authentication by API key.
Dataflow Web API: Change Log
Changes from version 16.4.2 to 16.5.1
New resources:
POST
/api/v1/dataimport/enersight/AdvancedImport
Changed resources:
GET
/api/v1/aggregator/{version}/{nodeId}/{revision}/{variableName}/{scenario}POST
/api/v1/hierarchy/HierarchyNodeGET
/api/v1/decline/WellGroups/{id}/{revision}GET
/api/v1/decline/Wells/{id}/{revision}GET
/api/v1/disconnecteddocuments/Data/{id}/{version}POST
/api/v1/disconnecteddocuments/Data/{id}/{version}GET
/api/v1/disconnecteddocuments/DataWithRangeMappings/{id}/{version}POST
/api/v1/documents/{id}/{version}/scenariosPOST
/api/v1/documents/comment/{id}/{version}/{revision}/{scenarioName}POST
/api/v1/documents/comment/{id}/{version}/{scenarioName}POST
/api/v1/documents/currency/{id}/{version}/{revision}GET
/api/v1/documents/data/{id}/{version}/{revision}POST
/api/v1/documents/data/{id}/{version}/{revision}/{scenarioName}POST
/api/v1/documents/data/{id}/{version}/{scenarioName}POST
/api/v1/documents/date/{id}/{version}/{revision}POST
/api/v1/documents/expression/{id}/{version}/{revision}/{scenarioName}POST
/api/v1/documents/expression/{id}/{version}/{scenarioName}POST
/api/v1/documents/multipledata/{id}/{version}/{revision}/{scenarioName}POST
/api/v1/documents/multipledata/{id}/{version}/{scenarioName}POST
/api/v1/documents/save/{id}/{version}/{revision}GET
/api/v1/documents/status/{id}/{version}/{revision}/{scenarioName}GET
/api/v1/documents/status/{id}/{version}/{scenarioName}POST
/api/v1/documents/unlockdocument/{id}/{version}POST
/api/v1/documents/validateexpression/{id}/{version}GET
/api/v1/documents/variables/{id}/{version}/{revision}/{scenarioName}GET
/api/v1/documents/variables/{id}/{version}/{scenarioName}GET
/api/v1/file/ShapeFeatures/{fileId}POST
/api/v1/dataimport/cash/AdvancedImportPOST
/api/v1/dataimport/db/AdvancedImportPOST
/api/v1/dataimport/db/TestConnectionPOST
/api/v1/dataimport/economics/AdvancedImportPOST
/api/v1/dataimport/financials/AdvancedImportPOST
/api/v1/preset/DataDELETE
/api/v1/preset/RemoveGET
/api/webdata/GetApplicationLaunchUriGET
/data/v1/AllVariablesTallGET
/data/v1/CategorizedVariablesViewGET
/data/v1/PeriodicVariablesViewGET
/data/v1/ScalarVariablesViewGET
/data/v1/VariableDefinitionsView()GET
/data/v1/Documents({documentVersionId})GET
/data/v1/Documents({documentVersionId})/LastRevisionGET
/data/v1/Documents({documentVersionId})/RevisionsGET
/data/v1/Documents({documentVersionId})/ScenariosGET
/data/v1/Documents({documentVersionId})/VariablesGET
/data/v1/VersionsGET
/data/v1/Versions({versionId})/DocumentsGET
/data/v1/CurrenciesGET
/data/v1/CurrencyDecksGET
/data/v1/NodeTypesGET
/data/v1/TagsGET
/data/v1/VariableCategoriesGET
/data/v1/VariableDefinitions
Changes from version 16.5.5 to 16.5.6
Changed resources:
POST
/api/v1/dataimport/db/AdvancedImport : Added parameter 'selectionInfos.importInfo.loadAllDocuments'
Changes from version 16.5.6 to 16.5.7
Changed resources:
POST
/api/v1/dataimport/economics/AdvancedImport : Added parameters 'selectionInfos.importInfo.resultSetGroupingType', 'selectionInfos.importInfo.groupedHierarchyPath', 'selectionInfos.importInfo.groupedHierarchyPathIds'POST
/api/v1/dataimport/financials/AdvancedImport : Added parameters 'selectionInfos.importInfo.resultSetGroupingType', 'selectionInfos.importInfo.groupedHierarchyPath', 'selectionInfos.importInfo.groupedHierarchyPathIds'
Changes from version 16.5.10 to 16.5.11
New resource:
GET
/api/v1/disconnecteddocuments/GetScenarioName/{id}/{version}
Changes from version 16.5.12 to 16.5.13
Changed resources:
POST
/api/v1/dataimport/enersight/AdvancedImport : Added parameters 'metricMappings.enersightVariableName', 'attributeMappings.enersightVariableName', 'scalarMappings.enersightVariableName', 'outcomeWeightingMapping.enersightVariableName', 'wiPartnerMapping.enersightVariableName'GET
/api/v1/preset/GetAll : Added returned property 'auxiliaryTemplateType.entityType'POST
/api/v1/preset/Data : Added parameter 'presetRequests.auxiliaryTemplateType.entityType'DELETE
/api/v1/preset/Remove : Added parameter 'presetRequests.auxiliaryTemplateType.entityType'
Changes from version 16.5.13 to 16.5.14
Changed resource:
POST
/api/v1/dataimport/db/AdvancedImport : Added parameter 'parameters.selectionInfos.importInfo.createScenarioTag'
Changes from version 16.5.16 to 16.5.22
New resources:
POST
/api/v1/integration/GetDataGET
/data/v1/ServiceInfo : Detects service availability and current credentialsGET
/api/v1/nodetypes (same as /api/v1/nodetypes/GetAll)GET
/api/v1/preset (same as /api/v1/preset/GetAll)GET
/api/v1/variabledefinitions (same as /api/v1/variabledefinitions/GetAll)GET
api/v1/versions (same as /api/v1/versions/GetAll)
Removed resources:
GET
/data/v1/CategorizedVariablesViewGET
/data/v1/PeriodicVariablesViewGET
/data/v1/ScalarVariablesViewGET
/data/v1/AllPeriodicVariablesWide({RowNumber})GET
/data/v1/AllScalarVariablesWide({RowNumber})GET
/data/v1/WellData({RowNumber})
Changes from version 16.5.23 to 16.5.24
New resources:
POST
/api/v1/report/generatereports : Schedules a report jobGET
/api/v1/report/status/{jobId} : Get job statusGET
/api/v1/report/download/{reportTaskId} : Download ReportsGET
/api/v1/report/exporttypesGET
/api/v1/reporttemplate/nodes : Get all report nodesGET
/api/v1/reporttemplate/metadata : Gets report template details for the report node ids specified by input parameters ('?reportNodeIds=1&reportNodeIds=2&...')
Economics Web API: Change Log
Changes from version 16.4.2 to 16.5.1
New resources:
GET
/api/v1/sensitivityresultsetsGET
/api/v1/sensitivityresultsets/{resultSetId}POST
/api/v1/sensitivityresultsets/{resultSetId}/Data
Changes from version 16.5.9 to 16.5.10
Changed resources:
GET
/data/v1/VariableDefinitions : Added returned property 'value.Unit' containing the unit definition data (unit system, unit scale)GET
/data/v1/VariableDefinitions({VariableId}) : Added returned property 'value.Unit'
Changes from version 16.5.10 to 16.5.11
Changed resources:
- Fixed an issue for the Tall and Wide requests ('AllPeriodicVariablesWide', 'AllScalarVariablesWide', 'AllVariablesTall') where, if there was no applied filter for the currency deck, the returned 'CurrencyDeck' value was misleadingly set to the result set run's configured currency deck although the actual currency deck used was the hierarchy currency deck. In these cases the returned value is now the hierarchy currency deck.
Changes from version 16.5.13 to 16.5.14
'ProjectScenarioName' and 'PriceScenario' are included in the response data from the '/data/v1/ResultSets' endpoints.
Price Deck scenario data is now included in the responses for the 'Tall' and 'Wide' API requests (and the OData selector is included in the queries generated by the QueryBuilder tool).
Changes from version 16.5.14 to 16.5.15
OData endpoints have a new query option '?fullduration=true' to allow data to be requested that is beyond the date set by the regime 'SetLastReportingDate'. The modified resources are:
- 'AllPeriodicVariablesWide', 'AllScalarVariablesWide', 'AllVariablesTall'
- '/data/v1/ResultSets({resultSetId})/ResultSetRuns({resultSetRunId})/RunProjects({projectId})/Variables'
- '/data/v1/ResultSets({resultSetId})/ResultSetRuns({resultSetRunId})/Variables'
Changes from version 16.5.16 to 16.5.22
New resources:
POST
/api/v1/integration/GetDataGET
/api/v1/hierarchies/{hierarchyId}/regimevariablesGET
/api/v1/reportnodes : Returns all report nodes (folders, standard and one-line summary reports)GET
/api/v1/reports/userreportsettings : Retrieves last used user report settingsPOST
/api/v1/reports/generatereports : Generates report with specified settingsGET
/api/v1/reports/hierarchy : Gets result set node hierarchy, can be built using report groupGET
/api/v1/reports/{reportUid}/hierarchy : Returns reports list along with folders
Removed resources:
GET
/data/v1/Regimes({Id})GET
/data/v1/AllPeriodicVariablesWide({RowNumber})GET
/data/v1/AllScalarVariablesWide({RowNumber})GET
/data/v1/VariableDefinitions({VariableId})
Changes from version 16.5.23 to 16.5.24
New resources:
GET
/api/v1/hierarchies/{hierarchyId}/currencydeck/currencies : Retrieves the currency deck currencies list for the specified hierarchyGET
/api/v1/reports/download/{reportUid} : Returns a result set report as a ZIP archiveGET
/api/v1/reports/download/{reportUid}/files : Returns single report contents as a file stream
Economics Calculation Web API: Change Log
First release of the API was in the 16.5 Update 10 release on 2021-01-22.
Changes from version 16.5.12 to 16.5.13
New resources:
GET
/api/v1/heartbeat Endpoint to check that the service is availableGET
/api/v1/hierarchies/{hierarchyId}/projects Gets project document data within the specified hierarchyDELETE
/api/v1/hierarchies/{hierarchyId}/projects Deletes projects within the specified hierarchyPATCH
/api/v1/hierarchies/{hierarchyId}/projects Update existing projects within the specified hierarchyPATCH
/api/v1/hierarchies/{hierarchyId}/project/{projectId} Update a single project within the specified hierarchyGET
/api/v1/hierarchies/{id}/regimeterms Retrieves collection of Hierarchy TermsPOST
/api/v1/hierarchies/{id}/regimeterms Creates or updates a collection of Terms in the HierarchyDELETE
/api/v1/hierarchies/{id}/regimeterms/{nodeType}:{nodeId} Delete the Terms for the specified hierarchy node
Removed resources:
GET
/api/v1/heartbeat/economicsGET
/api/v1/heartbeat/fusion
Changed resources:
POST
/api/v1/calculations : Added parameters 'settings.callbackSettings' (to send a callback notification to a specified Url)
Changes from version 16.5.13 to 16.5.14
New resources: endpoints for result sets, result set hierarchies, and incremental settings.
GET
/api/v1/hierarchies/{id}/incrementalsettings Retrieves collection of hierarchy Incremental SettingsPOST
/api/v1/hierarchies/{id}/incrementalsettings Creates or updates a collection of Incremental Settings in the hierarchyDELETE
/api/v1/hierarchies/{id}/incrementalsettings/{nodeId} Delete hierarchy Incremental SettingsGET
/api/v1/resultsetnodes Retrieves all nodes in the result set tree viewPOST
/api/v1/resultsets Creates a result setGET
/api/v1/resultsets/{id} Get an existing result setDELETE
/api/v1/resultsets/{id} Delete a result setGET
/api/v1/resultsets/{id}/runs/{runId} Get an existing result set runDELETE
/api/v1/resultsets/{id}/runs/{runId} Delete result set runPOST
/api/v1/calculations/{resultSetId} Trigger the calculation of an existing result set with the given id
Changed resources:
GET
/api/v1/hierarchies: Added returned properties 'projectScenarioNames', 'priceDeck.priceScenarios'GET
/api/v1/hierarchies/{id}: Added returned properties 'projectScenarioNames', 'priceDeck.priceScenarios'
Changes from version 16.5.14 to 16.5.15
New resources:
POST
/api/v1/resultsets/{id}/runs Create result set runsPUT
/api/v1/resultsets/{id}/runs Update result set runsPATCH
/api/v1/resultsets/{id} Update existing result set
Changed resource:
POST
/api/v1/hierarchies: Added the optional parameter 'isTransient' to indicate when the hierarchy is short-lived (default is true)
Changes from version 16.5.15 to 16.5.16
Changed resources:
GET
/api/v1/hierarchies/{hierarchyId}/projects : Added returned property 'items.settings.inheritWorkingInterest'POST
/api/v1/hierarchies/{hierarchyId}/projects : Added parameters 'projects.settings.inheritWorkingInterest', 'settings.inheritWorkingInterest'
Changes from version 16.5.16 to 16.5.22
New resources:
POST
/api/v1/calculations/{id}/cancel : Cancel a calculationGET
/api/v1/calculations/{id}/logs/csv : Get result set calculation log for all runsGET
/api/v1/regimenodes : Gets regimes folders structure with regimes as flat listGET
/api/v1/regimes/{id}/termvariables : Returns flexible term variables with variables values for each preset defined in a regimeDELETE
/api/v1/resultsetnodes/{id} : Deletes result set folder and all of its child folders and result setsPATCH
/api/v1/resultsetnodes/{id} : Renames result set folderGET
/api/v1/resultsetnodes/{folderId} : Returns result set folders and result sets that belongs to the result set folder with specified identifierPOST
/api/v1/resultsets/{id}/lock : Lock Result SetPOST
/api/v1/resultsets/{id}/unlock : Unlock Result SetHEAD
/api/v1/resultsets/{name} : Checks if result set exists with the specified namePOST
/api/v1/resultsetnodes : Creates Result Set FolderPUT
/api/v1/resultsets/{id} : Updates an existing result set with runs
Changed resources:
POST
/api/v1/calculations : Removed parameter 'settings.callbackSettings'GET
/api/v1/hierarchies : Added returned properties 'createdBy' (name of the user who created the hierarchy), 'partners' (list of hierarchy partners)GET
/api/v1/hierarchies/{id} : Added returned properties 'createdBy' (name of the user who created the hierarchy), 'partners' (list of hierarchy partners)POST
/api/v1/resultsets : Added parameters 'resultSetCreationModel.isUnweightedRingFence' (indicates if the result set is to apply unweighted ringfenced calculations; default is false), 'resultSetCreationModel.runs.priceSensitivities' (the price sensitivities to be applied to the price data in the result set run calculation)POST
/api/v1/resultsets/{id}/runs : Added parameter 'resultSetCreationModel.runs.priceSensitivities' (the price sensitivities to be applied to the price data in the result set run calculation)PUT
/api/v1/resultsets/{id}/runs : Added parameter 'resultSetRunUpdateModels.priceSensitivities' (the price sensitivities to be applied to the price data in the result set run calculation)GET
/api/v1/resultsets/{id} : Added returned properties 'isUnweightedRingFence' (indicates if the result set has unweighted ringfenced calculations applied), 'nodePath' (path to the Result Set node), 'runs.priceSensitivities' (the price sensitivities applied to the price data)GET
/api/v1/resultsets/{id}/runs/{runId} : Added returned property 'runs.priceSensitivities' (the price sensitivities applied to the price data)
Changes from version 16.5.23 to 16.5.24
New resources:
POST
/api/v1/resultsetnodes/{id}/copy : Copies a result set folder and all of its child folders and result sets
Changes from version 16.5.26 to 16.5.27
Changed resources:
POST
/api/v1/resultsets : Added parameter 'resultSetCreationModel.isResultSetIncrementalDisabled' to specify incremental calculations to be disabled for the new result set (default value is false)PUT
/api/v1/resultsets/{id} : Added parameter 'resultSetUpdateWithRunsModel.isResultSetIncrementalDisabled' to specify incremental calculations to be disabled (default value is false)GET
/api/v1/resultsets/{id} : Added returned property 'isResultSetIncrementalDisabled' which indicates if incremental calculations are disabled for the result set
Changes from version 16.5.30 to 16.5.31
New resources:
POST
/api/v1/calculations/{resultSetId}/reports : Create a calculation report job for Result Set dataGET
/api/v1/calculations/{resultSetId}/reports/{reportUid} : Gets created calculation report file in GZIP-compressed CSV format
Changed resources:
GET
/api/v1/resultsetnodes : Added returned property 'calculationStatus' - shows calculation status for a result set, and Null for other node typesGET
/api/v1/resultsetnodes/{folderId} : Added returned property 'calculationStatus'GET
/api/v1/resultsets/{id} : Added returned property 'runs.calculationStatus' - calculation status for the current runGET
/api/v1/resultsets/{id}/runs/{runId} : Added returned property 'calculationStatus' - calculation status for the current run
Financials Web API: Change Log
Changes from version 16.4.2 to 16.5.1
New resources:
GET
/api/v1/sensitivityresultsetsGET
/api/v1/sensitivityresultsets/{resultSetId}POST
/api/v1/sensitivityresultsets/{resultSetId}/Data
POST
/api/v1/hierarchies/{hierarchyId}/foldersGET
/api/v1/hierarchies/{hierarchyId}/projectsDELETE
/api/v1/hierarchies/{hierarchyId}/projectsPOST
/api/v1/hierarchies/{hierarchyId}/tasksGET
/api/v1/hierarchies/{hierarchyId}/tasks/{taskId}DELETE
/api/v1/hierarchies/{hierarchyId}/tasks/{taskId}GET
/api/v1/hierarchies/{hierarchyId}/tasks/{taskId}/logsGET
/api/v1/hierarchies/{name}
Changes from version 16.5.9 to 16.5.10
Changed resources:
GET
/data/v1/VariableDefinitions : Added returned property 'value.Unit' containing the unit definition data (unit system, unit scale)GET
/data/v1/VariableDefinitions({VariableId}) : Added returned property 'value.Unit'
Changes from version 16.5.10 to 16.5.11
Changed resources:
- Fixed an issue for the Tall and Wide requests ('AllPeriodicVariablesWide', 'AllScalarVariablesWide', 'AllVariablesTall') where, if there was no applied filter for the currency deck, the returned 'CurrencyDeck' value was misleadingly set to the result set run's configured currency deck although the actual currency deck used was the hierarchy currency deck. In these cases the returned value is now the hierarchy currency deck.
Changes from version 16.5.13 to 16.5.14
'ProjectScenarioName' is included in the response data from the '/data/v1/ResultSets' endpoints.
Changes from version 16.5.14 to 16.5.15
OData endpoints have a new query option '?fullduration=true' to allow data to be requested that is beyond the date set by the regime 'SetLastReportingDate'. The modified resources are:
- 'AllPeriodicVariablesWide', 'AllScalarVariablesWide', 'AllVariablesTall'
- '/data/v1/ResultSets({resultSetId})/ResultSetRuns({resultSetRunId})/RunProjects({projectId})/Variables'
- '/data/v1/ResultSets({resultSetId})/ResultSetRuns({resultSetRunId})/Variables'
Changes from version 16.5.16 to 16.5.22
New resources:
POST
/api/v1/integration/GetDataGET
/api/v1/hierarchies/{hierarchyId}/regimevariablesGET
/api/v1/reportnodes : Returns all report nodes (folders, standard and one-line summary reports)GET
/api/v1/reports/userreportsettings : Retrieves last used user report settingsPOST
/api/v1/reports/generatereports : Generates report with specified settingsGET
/api/v1/reports/hierarchy : Gets result set node hierarchy, can be built using report groupGET
/api/v1/reports/{reportUid}/hierarchy : Returns reports list along with folders
Removed resources:
GET
/data/v1/Regimes({Id})GET
/data/v1/AllPeriodicVariablesWide({RowNumber})GET
/data/v1/AllScalarVariablesWide({RowNumber})GET
/data/v1/VariableDefinitions({VariableId})
Changes from version 16.5.23 to 16.5.24
New resources:
GET
/api/v1/hierarchies/{hierarchyId}/currencydeck/currencies : Retrieves the currency deck currencies list for the specified hierarchyGET
/api/v1/reports/download/{reportUid} : Returns a result set report as a ZIP archiveGET
/api/v1/reports/download/{reportUid}/files : Returns single report contents as a file stream
PlanningSpace Web API: Change Log
Changes from version 16.5.6 to 16.5.7
New resources:
GET
/api/v1/users/apikeyexpiration Gets the API key expiry date-time for the current user
Changed resources:
GET
/api/v1/users : Added returned property 'apiKeyExpiration'POST
/api/v1/users : Added parameter 'user.apiKeyExpiration'GET
/api/v1/users/{id} : Added returned property 'apiKeyExpiration'PATCH
/api/v1/users/{id} : Added returned property 'apiKeyExpiration'POST
/api/v1/users/bulk : Added parameter 'users.apiKeyExpiration'
Changes from version 16.5.11 to 16.5.12
Changed resources:
GET
/api/v1/users/commonworkgroups : Added returned property 'externalGroup'GET
/api/v1/workgroups : Added returned property 'externalGroup'POST
/api/v1/workgroups : Added parameter and returned property 'externalGroup'GET
/api/v1/workgroups/{id} : Added returned property 'externalGroup'PATCH
/api/v1/workgroups/{id} : Added returned property 'externalGroup'POST
/api/v1/workgroups/bulk : Added parameter 'externalGroup'
Changes from version 16.5.12 to 16.5.13
New resource:
GET
/api/v1/authenticationmethods Retrieves a list of the enabled authentication methods for the tenant
Changes from version 16.5.15 to 16.5.16
Changed resources:
GET
/api/v1/users/commonworkgroups : Added returned property 'isLicenseWorkgroup'GET
/api/v1/workgroups : Added returned property 'isLicenseWorkgroup'POST
/api/v1/workgroups : Added parameter 'isLicenseWorkgroup', and returned property 'isLicenseWorkgroup'GET
/api/v1/workgroups/{id} : Added returned property 'isLicenseWorkgroup'PATCH
/api/v1/workgroups/{id} : Added returned property 'isLicenseWorkgroup'POST
/api/v1/workgroups/bulk : Added parameter 'workgroups.isLicenseWorkgroup'
Changes from version 16.5.24 to 16.5.25
New resource:
GET
/data/v1/auditlogs : Retrieves all audit logs
IPS Server Monitor Tenant API: Change Log
(No changes in the PlanningSpace 16.5 releases)